Update FebrlExample notebook to add DOCS_DIR construction#1316
Conversation
Update FebrlExample notebook to add DOCS_DIR construction.
There was a problem hiding this comment.
Pull request overview
Updates the Databricks FebrlExample notebook to construct a DOCS_DIR path after running the generateDocs phase so the generated documentation files can be listed and displayed.
Changes:
- Add
DOCS_DIRconstruction and use it to list/view generated docs aftergenerateDocs. - Update the notebook’s default
modelIdandoutputTablevalues to new date-stamped names. - Change Databricks notebook metadata
notebookName.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "notebookName": "DBOSS", | ||
| "widgets": {} |
There was a problem hiding this comment.
The notebook metadata notebookName is changed from FebrlExample to DBOSS, which appears unrelated to adding DOCS_DIR and may confuse consumers when importing/viewing the notebook. Consider keeping notebookName aligned with the file/notebook’s actual purpose/name, or omit changing it in this PR.
| "zinggDir = \"/models\"\n", | ||
| "modelId = \"zinggTestApr22\"" | ||
| "modelId = \"zinggTestApr28\"" |
There was a problem hiding this comment.
The PR description is focused on adding DOCS_DIR construction, but this hunk also changes the default modelId to a different date-stamped value. This makes the example less stable/reproducible and looks unrelated to the stated purpose; consider keeping a consistent default modelId (or deriving it from a parameter/widget) and limiting this PR to the DOCS_DIR change.
| "outputTable = \"zingg_catalog.output.febrlOutput28Apr\"\n", | ||
| "outputPipe = UCPipe(\"resultFebrl\", outputTable)\n", |
There was a problem hiding this comment.
This PR is described as adding DOCS_DIR construction, but it also renames the hard-coded outputTable to a new date-specific table. Unless this is required for the DOCS_DIR change, it would be better to avoid committing ephemeral table names (or make the table name configurable) to keep the notebook example repeatable.
Update FebrlExample notebook to add DOCS_DIR construction.
Update FebrlExample notebook to add DOCS_DIR construction.